<html><body>
<style>

body, h1, h2, h3, div, span, p, pre, a {
  margin: 0;
  padding: 0;
  border: 0;
  font-weight: inherit;
  font-style: inherit;
  font-size: 100%;
  font-family: inherit;
  vertical-align: baseline;
}

body {
  font-size: 13px;
  padding: 1em;
}

h1 {
  font-size: 26px;
  margin-bottom: 1em;
}

h2 {
  font-size: 24px;
  margin-bottom: 1em;
}

h3 {
  font-size: 20px;
  margin-bottom: 1em;
  margin-top: 1em;
}

pre, code {
  line-height: 1.5;
  font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}

pre {
  margin-top: 0.5em;
}

h1, h2, h3, p {
  font-family: Arial, sans serif;
}

h1, h2, h3 {
  border-bottom: solid #CCC 1px;
}

.toc_element {
  margin-top: 0.5em;
}

.firstline {
  margin-left: 2 em;
}

.method  {
  margin-top: 1em;
  border: solid 1px #CCC;
  padding: 1em;
  background: #EEE;
}

.details {
  font-weight: bold;
  font-size: 14px;
}

</style>

<h1><a href="contactcenterinsights_v1.html">Contact Center AI Insights API</a> . <a href="contactcenterinsights_v1.projects.html">projects</a> . <a href="contactcenterinsights_v1.projects.locations.html">locations</a> . <a href="contactcenterinsights_v1.projects.locations.assessmentRules.html">assessmentRules</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
  <code><a href="#close">close()</a></code></p>
<p class="firstline">Close httplib2 connections.</p>
<p class="toc_element">
  <code><a href="#create">create(parent, assessmentRuleId=None, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Creates an assessment rule.</p>
<p class="toc_element">
  <code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
<p class="firstline">Deletes an assessment rule.</p>
<p class="toc_element">
  <code><a href="#get">get(name, x__xgafv=None)</a></code></p>
<p class="firstline">Get an assessment rule.</p>
<p class="toc_element">
  <code><a href="#list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
<p class="firstline">Lists assessment rules.</p>
<p class="toc_element">
  <code><a href="#list_next">list_next()</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<p class="toc_element">
  <code><a href="#patch">patch(name, body=None, updateMask=None, x__xgafv=None)</a></code></p>
<p class="firstline">Updates an assessment rule.</p>
<h3>Method Details</h3>
<div class="method">
    <code class="details" id="close">close()</code>
  <pre>Close httplib2 connections.</pre>
</div>

<div class="method">
    <code class="details" id="create">create(parent, assessmentRuleId=None, body=None, x__xgafv=None)</code>
  <pre>Creates an assessment rule.

Args:
  parent: string, Required. The parent resource of the assessment rule. Required. The location to create a assessment rule for. Format: `projects//locations/` or `projects//locations/` (required)
  body: object, The request body.
    The object takes the form of:

{ # The CCAI Insights project wide assessment rule. This assessment rule will be applied to all conversations from the previous sampling cycle that match the sample rule defined in the assessment rule. One project can have multiple assessment rules.
  &quot;active&quot;: True or False, # If true, apply this rule to conversations. Otherwise, this rule is inactive.
  &quot;createTime&quot;: &quot;A String&quot;, # Output only. The time at which this assessment rule was created.
  &quot;displayName&quot;: &quot;A String&quot;, # Display Name of the assessment rule.
  &quot;name&quot;: &quot;A String&quot;, # Identifier. The resource name of the assessment rule. Format: projects/{project}/locations/{location}/assessmentRules/{assessment_rule}
  &quot;sampleRule&quot;: { # Message for sampling conversations. # The sample rule for the assessment rule.
    &quot;conversationFilter&quot;: &quot;A String&quot;, # To specify the filter for the conversions that should apply this sample rule. An empty filter means this sample rule applies to all conversations.
    &quot;dimension&quot;: &quot;A String&quot;, # Optional. Group by dimension to sample the conversation. If no dimension is provided, the sampling will be applied to the project level. Current supported dimensions is &#x27;quality_metadata.agent_info.agent_id&#x27;.
    &quot;samplePercentage&quot;: 3.14, # Percentage of conversations that we should sample based on the dimension between [0, 100].
    &quot;sampleRow&quot;: &quot;A String&quot;, # Number of the conversations that we should sample based on the dimension.
  },
  &quot;scheduleInfo&quot;: { # Message for schedule info. # Schedule info for the assessment rule.
    &quot;endTime&quot;: &quot;A String&quot;, # End time of the schedule. If not specified, will keep scheduling new pipelines for execution util the schedule is no longer active or deleted.
    &quot;schedule&quot;: &quot;A String&quot;, # The groc expression. Format: `every number [synchronized]` Time units can be: minutes, hours Synchronized is optional and indicates that the schedule should be synchronized to the start of the interval: every 5 minutes synchronized means 00:00, 00:05 ... Otherwise the start time is random within the interval. Example: `every 5 minutes` could be 00:02, 00:07, 00:12, ...
    &quot;startTime&quot;: &quot;A String&quot;, # Start time of the schedule. If not specified, will start as soon as the schedule is created.
    &quot;timeZone&quot;: &quot;A String&quot;, # The timezone to use for the groc expression. If not specified, defaults to UTC.
  },
  &quot;updateTime&quot;: &quot;A String&quot;, # Output only. The most recent time at which this assessment rule was updated.
}

  assessmentRuleId: string, Optional. A unique ID for the new AssessmentRule. This ID will become the final component of the AssessmentRule&#x27;s resource name. If no ID is specified, a server-generated ID will be used. This value should be 4-64 characters and must match the regular expression `^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$`.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # The CCAI Insights project wide assessment rule. This assessment rule will be applied to all conversations from the previous sampling cycle that match the sample rule defined in the assessment rule. One project can have multiple assessment rules.
  &quot;active&quot;: True or False, # If true, apply this rule to conversations. Otherwise, this rule is inactive.
  &quot;createTime&quot;: &quot;A String&quot;, # Output only. The time at which this assessment rule was created.
  &quot;displayName&quot;: &quot;A String&quot;, # Display Name of the assessment rule.
  &quot;name&quot;: &quot;A String&quot;, # Identifier. The resource name of the assessment rule. Format: projects/{project}/locations/{location}/assessmentRules/{assessment_rule}
  &quot;sampleRule&quot;: { # Message for sampling conversations. # The sample rule for the assessment rule.
    &quot;conversationFilter&quot;: &quot;A String&quot;, # To specify the filter for the conversions that should apply this sample rule. An empty filter means this sample rule applies to all conversations.
    &quot;dimension&quot;: &quot;A String&quot;, # Optional. Group by dimension to sample the conversation. If no dimension is provided, the sampling will be applied to the project level. Current supported dimensions is &#x27;quality_metadata.agent_info.agent_id&#x27;.
    &quot;samplePercentage&quot;: 3.14, # Percentage of conversations that we should sample based on the dimension between [0, 100].
    &quot;sampleRow&quot;: &quot;A String&quot;, # Number of the conversations that we should sample based on the dimension.
  },
  &quot;scheduleInfo&quot;: { # Message for schedule info. # Schedule info for the assessment rule.
    &quot;endTime&quot;: &quot;A String&quot;, # End time of the schedule. If not specified, will keep scheduling new pipelines for execution util the schedule is no longer active or deleted.
    &quot;schedule&quot;: &quot;A String&quot;, # The groc expression. Format: `every number [synchronized]` Time units can be: minutes, hours Synchronized is optional and indicates that the schedule should be synchronized to the start of the interval: every 5 minutes synchronized means 00:00, 00:05 ... Otherwise the start time is random within the interval. Example: `every 5 minutes` could be 00:02, 00:07, 00:12, ...
    &quot;startTime&quot;: &quot;A String&quot;, # Start time of the schedule. If not specified, will start as soon as the schedule is created.
    &quot;timeZone&quot;: &quot;A String&quot;, # The timezone to use for the groc expression. If not specified, defaults to UTC.
  },
  &quot;updateTime&quot;: &quot;A String&quot;, # Output only. The most recent time at which this assessment rule was updated.
}</pre>
</div>

<div class="method">
    <code class="details" id="delete">delete(name, x__xgafv=None)</code>
  <pre>Deletes an assessment rule.

Args:
  name: string, Required. The name of the assessment rule to delete. (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
}</pre>
</div>

<div class="method">
    <code class="details" id="get">get(name, x__xgafv=None)</code>
  <pre>Get an assessment rule.

Args:
  name: string, Required. The name of the assessment rule to get. (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # The CCAI Insights project wide assessment rule. This assessment rule will be applied to all conversations from the previous sampling cycle that match the sample rule defined in the assessment rule. One project can have multiple assessment rules.
  &quot;active&quot;: True or False, # If true, apply this rule to conversations. Otherwise, this rule is inactive.
  &quot;createTime&quot;: &quot;A String&quot;, # Output only. The time at which this assessment rule was created.
  &quot;displayName&quot;: &quot;A String&quot;, # Display Name of the assessment rule.
  &quot;name&quot;: &quot;A String&quot;, # Identifier. The resource name of the assessment rule. Format: projects/{project}/locations/{location}/assessmentRules/{assessment_rule}
  &quot;sampleRule&quot;: { # Message for sampling conversations. # The sample rule for the assessment rule.
    &quot;conversationFilter&quot;: &quot;A String&quot;, # To specify the filter for the conversions that should apply this sample rule. An empty filter means this sample rule applies to all conversations.
    &quot;dimension&quot;: &quot;A String&quot;, # Optional. Group by dimension to sample the conversation. If no dimension is provided, the sampling will be applied to the project level. Current supported dimensions is &#x27;quality_metadata.agent_info.agent_id&#x27;.
    &quot;samplePercentage&quot;: 3.14, # Percentage of conversations that we should sample based on the dimension between [0, 100].
    &quot;sampleRow&quot;: &quot;A String&quot;, # Number of the conversations that we should sample based on the dimension.
  },
  &quot;scheduleInfo&quot;: { # Message for schedule info. # Schedule info for the assessment rule.
    &quot;endTime&quot;: &quot;A String&quot;, # End time of the schedule. If not specified, will keep scheduling new pipelines for execution util the schedule is no longer active or deleted.
    &quot;schedule&quot;: &quot;A String&quot;, # The groc expression. Format: `every number [synchronized]` Time units can be: minutes, hours Synchronized is optional and indicates that the schedule should be synchronized to the start of the interval: every 5 minutes synchronized means 00:00, 00:05 ... Otherwise the start time is random within the interval. Example: `every 5 minutes` could be 00:02, 00:07, 00:12, ...
    &quot;startTime&quot;: &quot;A String&quot;, # Start time of the schedule. If not specified, will start as soon as the schedule is created.
    &quot;timeZone&quot;: &quot;A String&quot;, # The timezone to use for the groc expression. If not specified, defaults to UTC.
  },
  &quot;updateTime&quot;: &quot;A String&quot;, # Output only. The most recent time at which this assessment rule was updated.
}</pre>
</div>

<div class="method">
    <code class="details" id="list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</code>
  <pre>Lists assessment rules.

Args:
  parent: string, Required. The parent resource of the assessment rules. (required)
  pageSize: integer, Optional. The maximum number of assessment rule to return in the response. If this value is zero, the service will select a default size. A call may return fewer objects than requested. A non-empty `next_page_token` in the response indicates that more data is available.
  pageToken: string, Optional. The value returned by the last `ListAssessmentRulesResponse`; indicates that this is a continuation of a prior `ListAssessmentRules` call and the system should return the next page of data.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # The response of listing assessment rules.
  &quot;assessmentRules&quot;: [ # The assessment rules that match the request.
    { # The CCAI Insights project wide assessment rule. This assessment rule will be applied to all conversations from the previous sampling cycle that match the sample rule defined in the assessment rule. One project can have multiple assessment rules.
      &quot;active&quot;: True or False, # If true, apply this rule to conversations. Otherwise, this rule is inactive.
      &quot;createTime&quot;: &quot;A String&quot;, # Output only. The time at which this assessment rule was created.
      &quot;displayName&quot;: &quot;A String&quot;, # Display Name of the assessment rule.
      &quot;name&quot;: &quot;A String&quot;, # Identifier. The resource name of the assessment rule. Format: projects/{project}/locations/{location}/assessmentRules/{assessment_rule}
      &quot;sampleRule&quot;: { # Message for sampling conversations. # The sample rule for the assessment rule.
        &quot;conversationFilter&quot;: &quot;A String&quot;, # To specify the filter for the conversions that should apply this sample rule. An empty filter means this sample rule applies to all conversations.
        &quot;dimension&quot;: &quot;A String&quot;, # Optional. Group by dimension to sample the conversation. If no dimension is provided, the sampling will be applied to the project level. Current supported dimensions is &#x27;quality_metadata.agent_info.agent_id&#x27;.
        &quot;samplePercentage&quot;: 3.14, # Percentage of conversations that we should sample based on the dimension between [0, 100].
        &quot;sampleRow&quot;: &quot;A String&quot;, # Number of the conversations that we should sample based on the dimension.
      },
      &quot;scheduleInfo&quot;: { # Message for schedule info. # Schedule info for the assessment rule.
        &quot;endTime&quot;: &quot;A String&quot;, # End time of the schedule. If not specified, will keep scheduling new pipelines for execution util the schedule is no longer active or deleted.
        &quot;schedule&quot;: &quot;A String&quot;, # The groc expression. Format: `every number [synchronized]` Time units can be: minutes, hours Synchronized is optional and indicates that the schedule should be synchronized to the start of the interval: every 5 minutes synchronized means 00:00, 00:05 ... Otherwise the start time is random within the interval. Example: `every 5 minutes` could be 00:02, 00:07, 00:12, ...
        &quot;startTime&quot;: &quot;A String&quot;, # Start time of the schedule. If not specified, will start as soon as the schedule is created.
        &quot;timeZone&quot;: &quot;A String&quot;, # The timezone to use for the groc expression. If not specified, defaults to UTC.
      },
      &quot;updateTime&quot;: &quot;A String&quot;, # Output only. The most recent time at which this assessment rule was updated.
    },
  ],
  &quot;nextPageToken&quot;: &quot;A String&quot;, # A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.
}</pre>
</div>

<div class="method">
    <code class="details" id="list_next">list_next()</code>
  <pre>Retrieves the next page of results.

        Args:
          previous_request: The request for the previous page. (required)
          previous_response: The response from the request for the previous page. (required)

        Returns:
          A request object that you can call &#x27;execute()&#x27; on to request the next
          page. Returns None if there are no more items in the collection.
        </pre>
</div>

<div class="method">
    <code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code>
  <pre>Updates an assessment rule.

Args:
  name: string, Identifier. The resource name of the assessment rule. Format: projects/{project}/locations/{location}/assessmentRules/{assessment_rule} (required)
  body: object, The request body.
    The object takes the form of:

{ # The CCAI Insights project wide assessment rule. This assessment rule will be applied to all conversations from the previous sampling cycle that match the sample rule defined in the assessment rule. One project can have multiple assessment rules.
  &quot;active&quot;: True or False, # If true, apply this rule to conversations. Otherwise, this rule is inactive.
  &quot;createTime&quot;: &quot;A String&quot;, # Output only. The time at which this assessment rule was created.
  &quot;displayName&quot;: &quot;A String&quot;, # Display Name of the assessment rule.
  &quot;name&quot;: &quot;A String&quot;, # Identifier. The resource name of the assessment rule. Format: projects/{project}/locations/{location}/assessmentRules/{assessment_rule}
  &quot;sampleRule&quot;: { # Message for sampling conversations. # The sample rule for the assessment rule.
    &quot;conversationFilter&quot;: &quot;A String&quot;, # To specify the filter for the conversions that should apply this sample rule. An empty filter means this sample rule applies to all conversations.
    &quot;dimension&quot;: &quot;A String&quot;, # Optional. Group by dimension to sample the conversation. If no dimension is provided, the sampling will be applied to the project level. Current supported dimensions is &#x27;quality_metadata.agent_info.agent_id&#x27;.
    &quot;samplePercentage&quot;: 3.14, # Percentage of conversations that we should sample based on the dimension between [0, 100].
    &quot;sampleRow&quot;: &quot;A String&quot;, # Number of the conversations that we should sample based on the dimension.
  },
  &quot;scheduleInfo&quot;: { # Message for schedule info. # Schedule info for the assessment rule.
    &quot;endTime&quot;: &quot;A String&quot;, # End time of the schedule. If not specified, will keep scheduling new pipelines for execution util the schedule is no longer active or deleted.
    &quot;schedule&quot;: &quot;A String&quot;, # The groc expression. Format: `every number [synchronized]` Time units can be: minutes, hours Synchronized is optional and indicates that the schedule should be synchronized to the start of the interval: every 5 minutes synchronized means 00:00, 00:05 ... Otherwise the start time is random within the interval. Example: `every 5 minutes` could be 00:02, 00:07, 00:12, ...
    &quot;startTime&quot;: &quot;A String&quot;, # Start time of the schedule. If not specified, will start as soon as the schedule is created.
    &quot;timeZone&quot;: &quot;A String&quot;, # The timezone to use for the groc expression. If not specified, defaults to UTC.
  },
  &quot;updateTime&quot;: &quot;A String&quot;, # Output only. The most recent time at which this assessment rule was updated.
}

  updateMask: string, Optional. The list of fields to be updated. If the update_mask is not provided, the update will be applied to all fields.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # The CCAI Insights project wide assessment rule. This assessment rule will be applied to all conversations from the previous sampling cycle that match the sample rule defined in the assessment rule. One project can have multiple assessment rules.
  &quot;active&quot;: True or False, # If true, apply this rule to conversations. Otherwise, this rule is inactive.
  &quot;createTime&quot;: &quot;A String&quot;, # Output only. The time at which this assessment rule was created.
  &quot;displayName&quot;: &quot;A String&quot;, # Display Name of the assessment rule.
  &quot;name&quot;: &quot;A String&quot;, # Identifier. The resource name of the assessment rule. Format: projects/{project}/locations/{location}/assessmentRules/{assessment_rule}
  &quot;sampleRule&quot;: { # Message for sampling conversations. # The sample rule for the assessment rule.
    &quot;conversationFilter&quot;: &quot;A String&quot;, # To specify the filter for the conversions that should apply this sample rule. An empty filter means this sample rule applies to all conversations.
    &quot;dimension&quot;: &quot;A String&quot;, # Optional. Group by dimension to sample the conversation. If no dimension is provided, the sampling will be applied to the project level. Current supported dimensions is &#x27;quality_metadata.agent_info.agent_id&#x27;.
    &quot;samplePercentage&quot;: 3.14, # Percentage of conversations that we should sample based on the dimension between [0, 100].
    &quot;sampleRow&quot;: &quot;A String&quot;, # Number of the conversations that we should sample based on the dimension.
  },
  &quot;scheduleInfo&quot;: { # Message for schedule info. # Schedule info for the assessment rule.
    &quot;endTime&quot;: &quot;A String&quot;, # End time of the schedule. If not specified, will keep scheduling new pipelines for execution util the schedule is no longer active or deleted.
    &quot;schedule&quot;: &quot;A String&quot;, # The groc expression. Format: `every number [synchronized]` Time units can be: minutes, hours Synchronized is optional and indicates that the schedule should be synchronized to the start of the interval: every 5 minutes synchronized means 00:00, 00:05 ... Otherwise the start time is random within the interval. Example: `every 5 minutes` could be 00:02, 00:07, 00:12, ...
    &quot;startTime&quot;: &quot;A String&quot;, # Start time of the schedule. If not specified, will start as soon as the schedule is created.
    &quot;timeZone&quot;: &quot;A String&quot;, # The timezone to use for the groc expression. If not specified, defaults to UTC.
  },
  &quot;updateTime&quot;: &quot;A String&quot;, # Output only. The most recent time at which this assessment rule was updated.
}</pre>
</div>

</body></html>